<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>eRPC API Reference: erpc::RPMsgTransport Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">eRPC API Reference
   &#160;<span id="projectnumber">Rev. 1.5.0</span>
   </div>
   <div id="projectbrief">NXP Semiconductors</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>API&#160;Reference</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classerpc_1_1_r_p_msg_transport.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classerpc_1_1_r_p_msg_transport-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">erpc::RPMsgTransport Class Reference<div class="ingroups"><a class="el" href="group__transports.html">Transport Layers</a> &raquo; <a class="el" href="group__rpmsg__lite__transport.html">RPMsg-Lite</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classerpc_1_1_transport.html" title="Abstract interface for transport layer. ">Transport</a> that uses RPMsg zero copy API for interprocessor messaging.  
 <a href="classerpc_1_1_r_p_msg_transport.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="rpmsg__lite__transport_8h_source.html">rpmsg_lite_transport.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for erpc::RPMsgTransport:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classerpc_1_1_r_p_msg_transport__inherit__graph.svg" width="194" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for erpc::RPMsgTransport:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classerpc_1_1_r_p_msg_transport__coll__graph.svg" width="678" height="134"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a84a1c95e4a8ea69bd1bcfa80bb704253"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a84a1c95e4a8ea69bd1bcfa80bb704253">RPMsgTransport</a> ()</td></tr>
<tr class="memdesc:a84a1c95e4a8ea69bd1bcfa80bb704253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a84a1c95e4a8ea69bd1bcfa80bb704253">More...</a><br /></td></tr>
<tr class="separator:a84a1c95e4a8ea69bd1bcfa80bb704253"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae37c5a48c19eaf0f7999dc9bf38a1f56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae37c5a48c19eaf0f7999dc9bf38a1f56"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#ae37c5a48c19eaf0f7999dc9bf38a1f56">~RPMsgTransport</a> ()</td></tr>
<tr class="memdesc:ae37c5a48c19eaf0f7999dc9bf38a1f56"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classerpc_1_1_codec.html" title="Abstract serialization encoder/decoder interface. ">Codec</a> destructor. <br /></td></tr>
<tr class="separator:ae37c5a48c19eaf0f7999dc9bf38a1f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b676a48e88be6361054fa48ddad3305"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a9b676a48e88be6361054fa48ddad3305">init</a> (unsigned long src_addr, unsigned long dst_addr, void *base_address, unsigned long length, int rpmsg_link_id)</td></tr>
<tr class="memdesc:a9b676a48e88be6361054fa48ddad3305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization of <a class="el" href="classerpc_1_1_r_p_msg_transport.html" title="Transport that uses RPMsg zero copy API for interprocessor messaging. ">RPMsgTransport</a> layer - as RPMsg master.  <a href="#a9b676a48e88be6361054fa48ddad3305">More...</a><br /></td></tr>
<tr class="separator:a9b676a48e88be6361054fa48ddad3305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7610174242effe384edcf6e4a7893c24"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a7610174242effe384edcf6e4a7893c24">init</a> (unsigned long src_addr, unsigned long dst_addr, void *base_address, int rpmsg_link_id, void(*ready_cb)(void))</td></tr>
<tr class="memdesc:a7610174242effe384edcf6e4a7893c24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization of <a class="el" href="classerpc_1_1_r_p_msg_transport.html" title="Transport that uses RPMsg zero copy API for interprocessor messaging. ">RPMsgTransport</a> layer - as RPMsg remote.  <a href="#a7610174242effe384edcf6e4a7893c24">More...</a><br /></td></tr>
<tr class="separator:a7610174242effe384edcf6e4a7893c24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accaaae7170e9b1ae42a4cdf1b2213583"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#accaaae7170e9b1ae42a4cdf1b2213583">receive</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *message)</td></tr>
<tr class="memdesc:accaaae7170e9b1ae42a4cdf1b2213583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set message to first received message.  <a href="#accaaae7170e9b1ae42a4cdf1b2213583">More...</a><br /></td></tr>
<tr class="separator:accaaae7170e9b1ae42a4cdf1b2213583"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6060897b2c31b37876dccc357d274278"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a6060897b2c31b37876dccc357d274278">send</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *message)</td></tr>
<tr class="memdesc:a6060897b2c31b37876dccc357d274278"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to send prepared message.  <a href="#a6060897b2c31b37876dccc357d274278">More...</a><br /></td></tr>
<tr class="separator:a6060897b2c31b37876dccc357d274278"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af02ad81857e7a23338f30930976f8ec1"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#af02ad81857e7a23338f30930976f8ec1">hasMessage</a> ()</td></tr>
<tr class="memdesc:af02ad81857e7a23338f30930976f8ec1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to check if is message in receive queue and wait for processing.  <a href="#af02ad81857e7a23338f30930976f8ec1">More...</a><br /></td></tr>
<tr class="separator:af02ad81857e7a23338f30930976f8ec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classerpc_1_1_r_p_msg_base_transport"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classerpc_1_1_r_p_msg_base_transport')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classerpc_1_1_r_p_msg_base_transport.html">erpc::RPMsgBaseTransport</a></td></tr>
<tr class="memitem:a8eb7b6366277ae23fd3963d87aaf066b inherit pub_methods_classerpc_1_1_r_p_msg_base_transport"><td class="memItemLeft" align="right" valign="top">struct rpmsg_lite_instance *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_base_transport.html#a8eb7b6366277ae23fd3963d87aaf066b">get_rpmsg_lite_instance</a> ()</td></tr>
<tr class="memdesc:a8eb7b6366277ae23fd3963d87aaf066b inherit pub_methods_classerpc_1_1_r_p_msg_base_transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns pointer to instance of RPMSG lite.  <a href="#a8eb7b6366277ae23fd3963d87aaf066b">More...</a><br /></td></tr>
<tr class="separator:a8eb7b6366277ae23fd3963d87aaf066b inherit pub_methods_classerpc_1_1_r_p_msg_base_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classerpc_1_1_transport"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classerpc_1_1_transport')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classerpc_1_1_transport.html">erpc::Transport</a></td></tr>
<tr class="memitem:a895a468f9810eba023c68197edefb301 inherit pub_methods_classerpc_1_1_transport"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a895a468f9810eba023c68197edefb301"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_transport.html#a895a468f9810eba023c68197edefb301">Transport</a> ()</td></tr>
<tr class="memdesc:a895a468f9810eba023c68197edefb301 inherit pub_methods_classerpc_1_1_transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a895a468f9810eba023c68197edefb301 inherit pub_methods_classerpc_1_1_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75843918e2fbe211430cf5973caac47 inherit pub_methods_classerpc_1_1_transport"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac75843918e2fbe211430cf5973caac47"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_transport.html#ac75843918e2fbe211430cf5973caac47">~Transport</a> ()</td></tr>
<tr class="memdesc:ac75843918e2fbe211430cf5973caac47 inherit pub_methods_classerpc_1_1_transport"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classerpc_1_1_transport.html" title="Abstract interface for transport layer. ">Transport</a> destructor. <br /></td></tr>
<tr class="separator:ac75843918e2fbe211430cf5973caac47 inherit pub_methods_classerpc_1_1_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a077e72c8afa8caa483220faf45df62c6 inherit pub_methods_classerpc_1_1_transport"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_transport.html#a077e72c8afa8caa483220faf45df62c6">setCrc16</a> (<a class="el" href="classerpc_1_1_crc16.html">Crc16</a> *crcImpl)</td></tr>
<tr class="memdesc:a077e72c8afa8caa483220faf45df62c6 inherit pub_methods_classerpc_1_1_transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">This functions sets thre CRC-16 implementation.  <a href="#a077e72c8afa8caa483220faf45df62c6">More...</a><br /></td></tr>
<tr class="separator:a077e72c8afa8caa483220faf45df62c6 inherit pub_methods_classerpc_1_1_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a483582bf499b33effba9d2de47378436"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a483582bf499b33effba9d2de47378436">rpmsg_read_cb</a> (void *payload, int payload_len, unsigned long src, void *priv)</td></tr>
<tr class="memdesc:a483582bf499b33effba9d2de47378436"><td class="mdescLeft">&#160;</td><td class="mdescRight">RPMSG callback for receiving data.  <a href="#a483582bf499b33effba9d2de47378436">More...</a><br /></td></tr>
<tr class="separator:a483582bf499b33effba9d2de47378436"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a05ba7ce33f48a0c622fd3cec49f4b2a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classerpc_1_1_static_queue.html">StaticQueue</a>&lt; <a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a>, <a class="el" href="group__config.html#ga4c997c7ee5b73d96d9e11af367dbfd6a">ERPC_DEFAULT_BUFFERS_COUNT</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a05ba7ce33f48a0c622fd3cec49f4b2a2">m_messageQueue</a></td></tr>
<tr class="separator:a05ba7ce33f48a0c622fd3cec49f4b2a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b5a0095d4128ee4d9c1125dc83859a1"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a8b5a0095d4128ee4d9c1125dc83859a1">m_dst_addr</a></td></tr>
<tr class="separator:a8b5a0095d4128ee4d9c1125dc83859a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5287d7a0abc8384cbaaadfadb6ef1b3"><td class="memItemLeft" align="right" valign="top">struct rpmsg_lite_ept_static_context&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#aa5287d7a0abc8384cbaaadfadb6ef1b3">m_rpmsg_ept_context</a></td></tr>
<tr class="separator:aa5287d7a0abc8384cbaaadfadb6ef1b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b9bbb8ec36ea15a065356cd9f23c871"><td class="memItemLeft" align="right" valign="top">struct rpmsg_lite_endpoint *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a8b9bbb8ec36ea15a065356cd9f23c871">m_rpmsg_ept</a></td></tr>
<tr class="separator:a8b9bbb8ec36ea15a065356cd9f23c871"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a0c6e6c1024de77fe08c1439e2eabddd6"><td class="memItemLeft" align="right" valign="top">static struct rpmsg_lite_instance&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_transport.html#a0c6e6c1024de77fe08c1439e2eabddd6">s_rpmsg_ctxt</a></td></tr>
<tr class="separator:a0c6e6c1024de77fe08c1439e2eabddd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_classerpc_1_1_r_p_msg_base_transport"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classerpc_1_1_r_p_msg_base_transport')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classerpc_1_1_r_p_msg_base_transport.html">erpc::RPMsgBaseTransport</a></td></tr>
<tr class="memitem:abbb9e11e0a1e71baa21cddbbba92b36b inherit pro_static_attribs_classerpc_1_1_r_p_msg_base_transport"><td class="memItemLeft" align="right" valign="top">static struct rpmsg_lite_instance *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_base_transport.html#abbb9e11e0a1e71baa21cddbbba92b36b">s_rpmsg</a></td></tr>
<tr class="separator:abbb9e11e0a1e71baa21cddbbba92b36b inherit pro_static_attribs_classerpc_1_1_r_p_msg_base_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7994d488250d7f5ae3fa152839b5bb31 inherit pro_static_attribs_classerpc_1_1_r_p_msg_base_transport"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_r_p_msg_base_transport.html#a7994d488250d7f5ae3fa152839b5bb31">s_initialized</a></td></tr>
<tr class="separator:a7994d488250d7f5ae3fa152839b5bb31 inherit pro_static_attribs_classerpc_1_1_r_p_msg_base_transport"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classerpc_1_1_transport.html" title="Abstract interface for transport layer. ">Transport</a> that uses RPMsg zero copy API for interprocessor messaging. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a84a1c95e4a8ea69bd1bcfa80bb704253"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RPMsgTransport::RPMsgTransport </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<p>This function initializes object attributes. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9b676a48e88be6361054fa48ddad3305"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a> RPMsgTransport::init </td>
          <td>(</td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>src_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>dst_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>base_address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>rpmsg_link_id</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initialization of <a class="el" href="classerpc_1_1_r_p_msg_transport.html" title="Transport that uses RPMsg zero copy API for interprocessor messaging. ">RPMsgTransport</a> layer - as RPMsg master. </p>
<p>Call <a class="el" href="classerpc_1_1_r_p_msg_transport.html#a9b676a48e88be6361054fa48ddad3305" title="Initialization of RPMsgTransport layer - as RPMsg master. ">init()</a> for RPMsg. Create buffers for receiving messages.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">src_addr</td><td>Source address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dst_addr</td><td>Destination address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">base_address</td><td>RPMsg base address in the shared memory. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>RPMsg shared memory region length. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">rpmsg_link_id</td><td>Selection between what cores the communication will occur.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">kErpcStatus_Success</td><td>When rpmsg init function was executed successfully. </td></tr>
    <tr><td class="paramname">kErpcStatus_InitFailed</td><td>When rpmsg init function wasn't executed successfully. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7610174242effe384edcf6e4a7893c24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a> RPMsgTransport::init </td>
          <td>(</td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>src_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>dst_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>base_address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>rpmsg_link_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void(*)(void)&#160;</td>
          <td class="paramname"><em>ready_cb</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initialization of <a class="el" href="classerpc_1_1_r_p_msg_transport.html" title="Transport that uses RPMsg zero copy API for interprocessor messaging. ">RPMsgTransport</a> layer - as RPMsg remote. </p>
<p>Call <a class="el" href="classerpc_1_1_r_p_msg_transport.html#a9b676a48e88be6361054fa48ddad3305" title="Initialization of RPMsgTransport layer - as RPMsg master. ">init()</a> for RPMsg. Create buffers for receiving messages.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">src_addr</td><td>Source address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">dst_addr</td><td>Destination address. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">base_address</td><td>RPMsg base address in the shared memory. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">rpmsg_link_id</td><td>Selection between what cores the communication will occur. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">ready_cb</td><td>Callback called after RPMsg init is done and the core is ready.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">kErpcStatus_Success</td><td>When rpmsg init function was executed successfully. </td></tr>
    <tr><td class="paramname">kErpcStatus_InitFailed</td><td>When rpmsg init function wasn't executed successfully. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="accaaae7170e9b1ae42a4cdf1b2213583"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a> RPMsgTransport::receive </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *&#160;</td>
          <td class="paramname"><em>message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set message to first received message. </p>
<p>In loop while no message come.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>Message buffer, to which will be stored incoming message.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>kErpcStatus_Success </dd></dl>

<p>Implements <a class="el" href="classerpc_1_1_transport.html#a3f886733620e1a2fe00d12f36711dde5">erpc::Transport</a>.</p>

</div>
</div>
<a class="anchor" id="a6060897b2c31b37876dccc357d274278"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a> RPMsgTransport::send </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *&#160;</td>
          <td class="paramname"><em>message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Function to send prepared message. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>Pass message buffer to send.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">kErpcStatus_SendFailed</td><td>Failed to send message buffer. </td></tr>
    <tr><td class="paramname">kErpcStatus_Success</td><td>Successfully sent all data. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classerpc_1_1_transport.html#a4ede71b16625cba746818294148f9aba">erpc::Transport</a>.</p>

</div>
</div>
<a class="anchor" id="af02ad81857e7a23338f30930976f8ec1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool erpc::RPMsgTransport::hasMessage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Function to check if is message in receive queue and wait for processing. </p>
<p>This function should be called before function <a class="el" href="classerpc_1_1_r_p_msg_transport.html#accaaae7170e9b1ae42a4cdf1b2213583" title="Set message to first received message. ">receive()</a> to avoid waiting for new message.</p>
<dl class="section return"><dt>Returns</dt><dd>True if exist received message, else false. </dd></dl>

<p>Reimplemented from <a class="el" href="classerpc_1_1_transport.html#abee09d5af8f4a38ae83891afc6472066">erpc::Transport</a>.</p>

</div>
</div>
<a class="anchor" id="a483582bf499b33effba9d2de47378436"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int RPMsgTransport::rpmsg_read_cb </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>payload</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>payload_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>priv</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>RPMSG callback for receiving data. </p>
<p>This function is used as RPMSG receive callback in which is copied message to free message buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">payload</td><td>RPMSG data to receive. </td></tr>
    <tr><td class="paramname">payload_len</td><td>Length of data. </td></tr>
    <tr><td class="paramname">src</td><td>Source endpoint address. </td></tr>
    <tr><td class="paramname">priv</td><td>Callback data.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a05ba7ce33f48a0c622fd3cec49f4b2a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classerpc_1_1_static_queue.html">StaticQueue</a>&lt;<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a>, <a class="el" href="group__config.html#ga4c997c7ee5b73d96d9e11af367dbfd6a">ERPC_DEFAULT_BUFFERS_COUNT</a>&gt; erpc::RPMsgTransport::m_messageQueue</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Received messages. Queue of messages with buffers filled in rpmsg callback. </p>

</div>
</div>
<a class="anchor" id="a8b5a0095d4128ee4d9c1125dc83859a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long erpc::RPMsgTransport::m_dst_addr</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Destination address used by rpmsg. </p>

</div>
</div>
<a class="anchor" id="aa5287d7a0abc8384cbaaadfadb6ef1b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct rpmsg_lite_ept_static_context erpc::RPMsgTransport::m_rpmsg_ept_context</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>RPMsg Lite Endpoint static context. </p>

</div>
</div>
<a class="anchor" id="a8b9bbb8ec36ea15a065356cd9f23c871"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct rpmsg_lite_endpoint* erpc::RPMsgTransport::m_rpmsg_ept</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Pointer to RPMsg Lite Endpoint structure. </p>

</div>
</div>
<a class="anchor" id="a0c6e6c1024de77fe08c1439e2eabddd6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct rpmsg_lite_instance erpc::RPMsgTransport::s_rpmsg_ctxt</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Context for RPMsg Lite stack instance. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="rpmsg__lite__transport_8h_source.html">rpmsg_lite_transport.h</a></li>
<li>rpmsg_lite_transport.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul class="foot">
    <li class="footer">&copy; 2016 NXP Semiconductors. All rights reserved.
    </li>
  </ul>
</div>
</body>
</html>
